<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html xmlns:yui="http://yuilibrary.com/rdf/1.0/yui.rdf#">
<head>
    <meta http-equiv="content-type" content="text/html; charset=UTF-8" />
	<title>API: highlight   highlight-accentfold.js  (YUI Library)</title>

	<link rel="stylesheet" type="text/css" href="assets/reset-fonts-grids-min.css" />
	<link rel="stylesheet" type="text/css" href="assets/api.css" />

    <script type="text/javascript" src="assets/api-js"></script>
    <script type="text/javascript" src="assets/ac-js"></script>
</head>

<body id="yahoo-com">

<div id="doc3" class="yui-t2">
	<div id="hd">
        <h1><a href="http://developer.yahoo.com/yui/" title="Yahoo! UI Library">Yahoo! UI Library</a></h1>
        <h3>highlight&nbsp; <span class="subtitle">3.3.0</span></h3>
        <a href="./index.html" title="Yahoo! UI Library">Yahoo! UI Library</a> 
            &gt; <a href="./module_highlight.html" title="highlight">highlight</a>
                
                 &gt; highlight-accentfold.js (source view) 
        <form onsubmit="return false">
            <div id="propertysearch">
                Search: <input autocomplete="off" id="searchinput" />
                <div id="searchresults">
                    &nbsp;
                </div>
            </div>
        </form>
	</div>

	<div id="bd">
		<div id="yui-main">
			<div class="yui-b">
            <form action="#" name="yui-classopts-form" method="get" id="yui-classopts-form">
                <fieldset>
                    <legend>Filters</legend>
                <span class="classopts"><input type="checkbox" name="show_private" id="show_private" /> <label for="show_private">Show Private</label></span>
                <span class="classopts"><input type="checkbox" name="show_protected" id="show_protected" /> <label for="show_protected">Show Protected</label></span>
                <span class="classopts"><input type="checkbox" name="show_deprecated" id="show_deprecated" /> <label for="show_deprecated">Show Deprecated</label></span>
                </fieldset>
            </form>

                    <div id="srcout">
                        <style>
                            #doc3 .classopts { display:none; }
                        </style>
                        <div class="highlight"><pre><span class="cm">/**</span>
<span class="cm"> * Adds accent-folding highlighters to &lt;code&gt;Y.Highlight&lt;/code&gt;.</span>
<span class="cm"> *</span>
<span class="cm"> * @module highlight</span>
<span class="cm"> * @submodule highlight-accentfold</span>
<span class="cm"> */</span>

<span class="cm">/**</span>
<span class="cm"> * @class Highlight</span>
<span class="cm"> * @static</span>
<span class="cm"> */</span>

<span class="kd">var</span> <span class="nx">AccentFold</span> <span class="o">=</span> <span class="nx">Y</span><span class="p">.</span><span class="nx">Text</span><span class="p">.</span><span class="nx">AccentFold</span><span class="p">,</span>
    <span class="nx">Escape</span>     <span class="o">=</span> <span class="nx">Y</span><span class="p">.</span><span class="nx">Escape</span><span class="p">,</span>

    <span class="nx">EMPTY_OBJECT</span> <span class="o">=</span> <span class="p">{},</span>

<span class="nx">Highlight</span> <span class="o">=</span> <span class="nx">Y</span><span class="p">.</span><span class="nx">mix</span><span class="p">(</span><span class="nx">Y</span><span class="p">.</span><span class="nx">Highlight</span><span class="p">,</span> <span class="p">{</span>
    <span class="c1">// -- Public Static Methods ------------------------------------------------</span>

    <span class="cm">/**</span>
<span class="cm">     * Accent-folding version of &lt;code&gt;all()&lt;/code&gt;.</span>
<span class="cm">     *</span>
<span class="cm">     * @method allFold</span>
<span class="cm">     * @param {String} haystack String to apply highlighting to.</span>
<span class="cm">     * @param {String|Array} needles String or array of strings that should be</span>
<span class="cm">     *   highlighted.</span>
<span class="cm">     * @param {Object} options (optional) Options object, which may contain</span>
<span class="cm">     *   zero or more of the following properties:</span>
<span class="cm">     *</span>
<span class="cm">     * &lt;dl&gt;</span>
<span class="cm">     *   &lt;dt&gt;startsWith (Boolean)&lt;dt&gt;</span>
<span class="cm">     *   &lt;dd&gt;</span>
<span class="cm">     *     By default, needles are highlighted wherever they appear in the</span>
<span class="cm">     *     haystack. If &lt;code&gt;startsWith&lt;/code&gt; is &lt;code&gt;true&lt;/code&gt;, matches</span>
<span class="cm">     *     must be anchored to the beginning of the string.</span>
<span class="cm">     *   &lt;/dd&gt;</span>
<span class="cm">     * &lt;/dl&gt;</span>
<span class="cm">     *</span>
<span class="cm">     * @return {String} Escaped and highlighted copy of &lt;em&gt;haystack&lt;/em&gt;.</span>
<span class="cm">     * @static</span>
<span class="cm">     */</span>
    <span class="nx">allFold</span><span class="o">:</span> <span class="kd">function</span> <span class="p">(</span><span class="nx">haystack</span><span class="p">,</span> <span class="nx">needles</span><span class="p">,</span> <span class="nx">options</span><span class="p">)</span> <span class="p">{</span>
        <span class="kd">var</span> <span class="nx">template</span> <span class="o">=</span> <span class="nx">Highlight</span><span class="p">.</span><span class="nx">_TEMPLATE</span><span class="p">,</span>
            <span class="nx">result</span>   <span class="o">=</span> <span class="p">[],</span>
            <span class="nx">startPos</span> <span class="o">=</span> <span class="mi">0</span><span class="p">;</span>

        <span class="nx">options</span> <span class="o">=</span> <span class="nx">Y</span><span class="p">.</span><span class="nx">merge</span><span class="p">({</span>
            <span class="c1">// While the highlight regex operates on the accent-folded strings,</span>
            <span class="c1">// this replacer will highlight the matched positions in the</span>
            <span class="c1">// original string.</span>
            <span class="c1">//</span>
            <span class="c1">// Note: this implementation doesn&#39;t handle multi-character folds,</span>
            <span class="c1">// like &quot;æ&quot; -&gt; &quot;ae&quot;. Doing so correctly would be prohibitively</span>
            <span class="c1">// expensive both in terms of code size and runtime performance, so</span>
            <span class="c1">// I&#39;ve chosen to take the pragmatic route and just not do it at</span>
            <span class="c1">// all. This is one of many reasons why accent folding is best done</span>
            <span class="c1">// on the server.</span>
            <span class="nx">replacer</span><span class="o">:</span> <span class="kd">function</span> <span class="p">(</span><span class="nx">match</span><span class="p">,</span> <span class="nx">p1</span><span class="p">,</span> <span class="nx">foldedNeedle</span><span class="p">,</span> <span class="nx">pos</span><span class="p">)</span> <span class="p">{</span>
                <span class="kd">var</span> <span class="nx">len</span><span class="p">;</span>

                <span class="c1">// Ignore matches inside HTML entities.</span>
                <span class="k">if</span> <span class="p">(</span><span class="nx">p1</span> <span class="o">&amp;&amp;</span> <span class="o">!</span><span class="p">(</span><span class="sr">/\s/</span><span class="p">).</span><span class="nx">test</span><span class="p">(</span><span class="nx">foldedNeedle</span><span class="p">))</span> <span class="p">{</span>
                    <span class="k">return</span> <span class="nx">match</span><span class="p">;</span>
                <span class="p">}</span>

                <span class="nx">len</span> <span class="o">=</span> <span class="nx">foldedNeedle</span><span class="p">.</span><span class="nx">length</span><span class="p">;</span>

                <span class="nx">result</span><span class="p">.</span><span class="nx">push</span><span class="p">(</span><span class="nx">haystack</span><span class="p">.</span><span class="nx">substring</span><span class="p">(</span><span class="nx">startPos</span><span class="p">,</span> <span class="nx">pos</span><span class="p">)</span> <span class="o">+</span>
                        <span class="nx">template</span><span class="p">.</span><span class="nx">replace</span><span class="p">(</span><span class="sr">/\{s\}/g</span><span class="p">,</span> <span class="nx">haystack</span><span class="p">.</span><span class="nx">substr</span><span class="p">(</span><span class="nx">pos</span><span class="p">,</span> <span class="nx">len</span><span class="p">)));</span>

                <span class="nx">startPos</span> <span class="o">=</span> <span class="nx">pos</span> <span class="o">+</span> <span class="nx">len</span><span class="p">;</span>
            <span class="p">}</span>
        <span class="p">},</span> <span class="nx">options</span> <span class="o">||</span> <span class="nx">EMPTY_OBJECT</span><span class="p">);</span>

        <span class="c1">// Run the highlighter on the folded strings. We don&#39;t care about the</span>
        <span class="c1">// output; our replacer function will build the canonical highlighted</span>
        <span class="c1">// string, with original accented characters.</span>
        <span class="nx">Highlight</span><span class="p">.</span><span class="nx">all</span><span class="p">(</span><span class="nx">AccentFold</span><span class="p">.</span><span class="nx">fold</span><span class="p">(</span><span class="nx">haystack</span><span class="p">),</span> <span class="nx">AccentFold</span><span class="p">.</span><span class="nx">fold</span><span class="p">(</span><span class="nx">needles</span><span class="p">),</span>
                <span class="nx">options</span><span class="p">);</span>

        <span class="c1">// Tack on the remainder of the haystack that wasn&#39;t highlighted, if</span>
        <span class="c1">// any.</span>
        <span class="k">if</span> <span class="p">(</span><span class="nx">startPos</span> <span class="o">&lt;</span> <span class="nx">haystack</span><span class="p">.</span><span class="nx">length</span> <span class="o">-</span> <span class="mi">1</span><span class="p">)</span> <span class="p">{</span>
            <span class="nx">result</span><span class="p">.</span><span class="nx">push</span><span class="p">(</span><span class="nx">haystack</span><span class="p">.</span><span class="nx">substr</span><span class="p">(</span><span class="nx">startPos</span><span class="p">));</span>
        <span class="p">}</span>

        <span class="k">return</span> <span class="nx">result</span><span class="p">.</span><span class="nx">join</span><span class="p">(</span><span class="s1">&#39;&#39;</span><span class="p">);</span>
    <span class="p">},</span>

    <span class="cm">/**</span>
<span class="cm">     * Accent-folding version of &lt;code&gt;start()&lt;/code&gt;.</span>
<span class="cm">     *</span>
<span class="cm">     * @method startFold</span>
<span class="cm">     * @param {String} haystack String to apply highlighting to.</span>
<span class="cm">     * @param {String|Array} needles String or array of strings that should be</span>
<span class="cm">     *   highlighted.</span>
<span class="cm">     * @return {String} Escaped and highlighted copy of &lt;em&gt;haystack&lt;/em&gt;.</span>
<span class="cm">     * @static</span>
<span class="cm">     */</span>
    <span class="nx">startFold</span><span class="o">:</span> <span class="kd">function</span> <span class="p">(</span><span class="nx">haystack</span><span class="p">,</span> <span class="nx">needles</span><span class="p">)</span> <span class="p">{</span>
        <span class="k">return</span> <span class="nx">Highlight</span><span class="p">.</span><span class="nx">allFold</span><span class="p">(</span><span class="nx">haystack</span><span class="p">,</span> <span class="nx">needles</span><span class="p">,</span> <span class="p">{</span><span class="nx">startsWith</span><span class="o">:</span> <span class="kc">true</span><span class="p">});</span>
    <span class="p">},</span>

    <span class="cm">/**</span>
<span class="cm">     * Accent-folding version of &lt;code&gt;words()&lt;/code&gt;.</span>
<span class="cm">     *</span>
<span class="cm">     * @method wordsFold</span>
<span class="cm">     * @param {String} haystack String to apply highlighting to.</span>
<span class="cm">     * @param {String|Array} needles String or array of strings containing words</span>
<span class="cm">     *   that should be highlighted. If a string is passed, it will be split</span>
<span class="cm">     *   into words; if an array is passed, it is assumed to have already been</span>
<span class="cm">     *   split.</span>
<span class="cm">     * @return {String} Escaped and highlighted copy of &lt;em&gt;haystack&lt;/em&gt;.</span>
<span class="cm">     * @static</span>
<span class="cm">     */</span>
    <span class="nx">wordsFold</span><span class="o">:</span> <span class="kd">function</span> <span class="p">(</span><span class="nx">haystack</span><span class="p">,</span> <span class="nx">needles</span><span class="p">)</span> <span class="p">{</span>
        <span class="kd">var</span> <span class="nx">template</span> <span class="o">=</span> <span class="nx">Highlight</span><span class="p">.</span><span class="nx">_TEMPLATE</span><span class="p">;</span>

        <span class="k">return</span> <span class="nx">Highlight</span><span class="p">.</span><span class="nx">words</span><span class="p">(</span><span class="nx">haystack</span><span class="p">,</span> <span class="nx">AccentFold</span><span class="p">.</span><span class="nx">fold</span><span class="p">(</span><span class="nx">needles</span><span class="p">),</span> <span class="p">{</span>
            <span class="nx">mapper</span><span class="o">:</span> <span class="kd">function</span> <span class="p">(</span><span class="nx">word</span><span class="p">,</span> <span class="nx">needles</span><span class="p">)</span> <span class="p">{</span>
                <span class="k">if</span> <span class="p">(</span><span class="nx">needles</span><span class="p">.</span><span class="nx">hasOwnProperty</span><span class="p">(</span><span class="nx">AccentFold</span><span class="p">.</span><span class="nx">fold</span><span class="p">(</span><span class="nx">word</span><span class="p">)))</span> <span class="p">{</span>
                    <span class="k">return</span> <span class="nx">template</span><span class="p">.</span><span class="nx">replace</span><span class="p">(</span><span class="sr">/\{s\}/g</span><span class="p">,</span> <span class="nx">Escape</span><span class="p">.</span><span class="nx">html</span><span class="p">(</span><span class="nx">word</span><span class="p">));</span>
                <span class="p">}</span>

                <span class="k">return</span> <span class="nx">Escape</span><span class="p">.</span><span class="nx">html</span><span class="p">(</span><span class="nx">word</span><span class="p">);</span>
            <span class="p">}</span>
        <span class="p">});</span>
    <span class="p">}</span>
<span class="p">});</span>
</pre></div>

                    </div>
			</div>
		</div>
		<div class="yui-b">
            <div class="nav">

                    <div id="moduleList" class="module">
                        <h4>Modules</h4>
                        <ul class="content">
                                <li class=""><a href="module_align-plugin.html" title="align-plugin">align-plugin</a></li>
                                <li class=""><a href="module_anim.html" title="anim">anim</a></li>
                                <li class=""><a href="module_arraysort.html" title="arraysort">arraysort</a></li>
                                <li class=""><a href="module_async-queue.html" title="async-queue">async-queue</a></li>
                                <li class=""><a href="module_attribute.html" title="attribute">attribute</a></li>
                                <li class=""><a href="module_autocomplete.html" title="autocomplete">autocomplete</a></li>
                                <li class=""><a href="module_base.html" title="base">base</a></li>
                                <li class=""><a href="module_cache.html" title="cache">cache</a></li>
                                <li class=""><a href="module_charts.html" title="charts">charts</a></li>
                                <li class=""><a href="module_classnamemanager.html" title="classnamemanager">classnamemanager</a></li>
                                <li class=""><a href="module_collection.html" title="collection">collection</a></li>
                                <li class=""><a href="module_console.html" title="console">console</a></li>
                                <li class=""><a href="module_console-filters.html" title="console-filters">console-filters</a></li>
                                <li class=""><a href="module_cookie.html" title="cookie">cookie</a></li>
                                <li class=""><a href="module_dataschema.html" title="dataschema">dataschema</a></li>
                                <li class=""><a href="module_datasource.html" title="datasource">datasource</a></li>
                                <li class=""><a href="module_datatable.html" title="datatable">datatable</a></li>
                                <li class=""><a href="module_datatype.html" title="datatype">datatype</a></li>
                                <li class=""><a href="module_dd.html" title="dd">dd</a></li>
                                <li class=""><a href="module_dial.html" title="dial">dial</a></li>
                                <li class=""><a href="module_dom.html" title="dom">dom</a></li>
                                <li class=""><a href="module_dump.html" title="dump">dump</a></li>
                                <li class=""><a href="module_editor.html" title="editor">editor</a></li>
                                <li class=""><a href="module_escape.html" title="escape">escape</a></li>
                                <li class=""><a href="module_event.html" title="event">event</a></li>
                                <li class=""><a href="module_event-custom.html" title="event-custom">event-custom</a></li>
                                <li class=""><a href="module_event-gestures.html" title="event-gestures">event-gestures</a></li>
                                <li class=""><a href="module_event-simulate.html" title="event-simulate">event-simulate</a></li>
                                <li class=""><a href="module_event-touch.html" title="event-touch">event-touch</a></li>
                                <li class=""><a href="module_event-valuechange.html" title="event-valuechange">event-valuechange</a></li>
                                <li class="selected"><a href="module_highlight.html" title="highlight">highlight</a></li>
                                <li class=""><a href="module_history.html" title="history">history</a></li>
                                <li class=""><a href="module_history-deprecated.html" title="history-deprecated">history-deprecated</a></li>
                                <li class=""><a href="module_imageloader.html" title="imageloader">imageloader</a></li>
                                <li class=""><a href="module_intl.html" title="intl">intl</a></li>
                                <li class=""><a href="module_io.html" title="io">io</a></li>
                                <li class=""><a href="module_json.html" title="json">json</a></li>
                                <li class=""><a href="module_jsonp.html" title="jsonp">jsonp</a></li>
                                <li class=""><a href="module_loader.html" title="loader">loader</a></li>
                                <li class=""><a href="module_node.html" title="node">node</a></li>
                                <li class=""><a href="module_node-flick.html" title="node-flick">node-flick</a></li>
                                <li class=""><a href="module_node-focusmanager.html" title="node-focusmanager">node-focusmanager</a></li>
                                <li class=""><a href="module_node-menunav.html" title="node-menunav">node-menunav</a></li>
                                <li class=""><a href="module_oop.html" title="oop">oop</a></li>
                                <li class=""><a href="module_overlay.html" title="overlay">overlay</a></li>
                                <li class=""><a href="module_plugin.html" title="plugin">plugin</a></li>
                                <li class=""><a href="module_pluginhost.html" title="pluginhost">pluginhost</a></li>
                                <li class=""><a href="module_pluginhost-base.html" title="pluginhost-base">pluginhost-base</a></li>
                                <li class=""><a href="module_profiler.html" title="profiler">profiler</a></li>
                                <li class=""><a href="module_querystring.html" title="querystring">querystring</a></li>
                                <li class=""><a href="module_queue-promote.html" title="queue-promote">queue-promote</a></li>
                                <li class=""><a href="module_recordset.html" title="recordset">recordset</a></li>
                                <li class=""><a href="module_resize.html" title="resize">resize</a></li>
                                <li class=""><a href="module_scrollview.html" title="scrollview">scrollview</a></li>
                                <li class=""><a href="module_scrollview-base.html" title="scrollview-base">scrollview-base</a></li>
                                <li class=""><a href="module_scrollview-base-ie.html" title="scrollview-base-ie">scrollview-base-ie</a></li>
                                <li class=""><a href="module_scrollview-paginator.html" title="scrollview-paginator">scrollview-paginator</a></li>
                                <li class=""><a href="module_scrollview-scrollbars.html" title="scrollview-scrollbars">scrollview-scrollbars</a></li>
                                <li class=""><a href="module_shim-plugin.html" title="shim-plugin">shim-plugin</a></li>
                                <li class=""><a href="module_slider.html" title="slider">slider</a></li>
                                <li class=""><a href="module_sortable.html" title="sortable">sortable</a></li>
                                <li class=""><a href="module_stylesheet.html" title="stylesheet">stylesheet</a></li>
                                <li class=""><a href="module_substitute.html" title="substitute">substitute</a></li>
                                <li class=""><a href="module_swf.html" title="swf">swf</a></li>
                                <li class=""><a href="module_swfdetect.html" title="swfdetect">swfdetect</a></li>
                                <li class=""><a href="module_tabview.html" title="tabview">tabview</a></li>
                                <li class=""><a href="module_test.html" title="test">test</a></li>
                                <li class=""><a href="module_text.html" title="text">text</a></li>
                                <li class=""><a href="module_transition.html" title="transition">transition</a></li>
                                <li class=""><a href="module_uploader.html" title="uploader">uploader</a></li>
                                <li class=""><a href="module_widget.html" title="widget">widget</a></li>
                                <li class=""><a href="module_widget-anim.html" title="widget-anim">widget-anim</a></li>
                                <li class=""><a href="module_widget-base-ie.html" title="widget-base-ie">widget-base-ie</a></li>
                                <li class=""><a href="module_widget-child.html" title="widget-child">widget-child</a></li>
                                <li class=""><a href="module_widget-locale.html" title="widget-locale">widget-locale</a></li>
                                <li class=""><a href="module_widget-parent.html" title="widget-parent">widget-parent</a></li>
                                <li class=""><a href="module_widget-position.html" title="widget-position">widget-position</a></li>
                                <li class=""><a href="module_widget-position-align.html" title="widget-position-align">widget-position-align</a></li>
                                <li class=""><a href="module_widget-position-constrain.html" title="widget-position-constrain">widget-position-constrain</a></li>
                                <li class=""><a href="module_widget-stack.html" title="widget-stack">widget-stack</a></li>
                                <li class=""><a href="module_widget-stdmod.html" title="widget-stdmod">widget-stdmod</a></li>
                                <li class=""><a href="module_yql.html" title="yql">yql</a></li>
                                <li class=""><a href="module_yui.html" title="yui">yui</a></li>
                        </ul>
                    </div>

                    <div id="classList" class="module">
                        <h4>Classes</h4>
                        <ul class="content">
                                <li class=""><a href="Highlight.html" title="Highlight">Highlight</a></li>
                        </ul>
                    </div>

                    <div id="fileList" class="module">
                        <h4>Files</h4>
                        <ul class="content">        
                                <li class="selected"><a href="highlight-accentfold.js.html" title="highlight-accentfold.js">highlight-accentfold.js</a></li>
                                <li class=""><a href="highlight-base.js.html" title="highlight-base.js">highlight-base.js</a></li>
                        </ul>
                    </div>





            </div>
		</div>
	</div>
	<div id="ft">
        <hr />
        Copyright &copy; 2011 Yahoo! Inc. All rights reserved.
	</div>
</div>
<script type="text/javascript">

    var ALL_YUI_PROPS = [{"access": "", "host": "Highlight", "name": "all", "url": "Highlight.html#method_all", "type": "method"}, {"access": "", "host": "Highlight", "name": "allCase", "url": "Highlight.html#method_allCase", "type": "method"}, {"access": "", "host": "Highlight", "name": "allFold", "url": "Highlight.html#method_allFold", "type": "method"}, {"access": "protected", "host": "Highlight", "name": "_REGEX", "url": "Highlight.html#property__REGEX", "type": "property"}, {"access": "protected", "host": "Highlight", "name": "_REPLACER", "url": "Highlight.html#property__REPLACER", "type": "property"}, {"access": "", "host": "Highlight", "name": "start", "url": "Highlight.html#method_start", "type": "method"}, {"access": "", "host": "Highlight", "name": "startCase", "url": "Highlight.html#method_startCase", "type": "method"}, {"access": "", "host": "Highlight", "name": "startFold", "url": "Highlight.html#method_startFold", "type": "method"}, {"access": "protected", "host": "Highlight", "name": "_START_REGEX", "url": "Highlight.html#property__START_REGEX", "type": "property"}, {"access": "protected", "host": "Highlight", "name": "_TEMPLATE", "url": "Highlight.html#property__TEMPLATE", "type": "property"}, {"access": "", "host": "Highlight", "name": "words", "url": "Highlight.html#method_words", "type": "method"}, {"access": "", "host": "Highlight", "name": "wordsCase", "url": "Highlight.html#method_wordsCase", "type": "method"}, {"access": "", "host": "Highlight", "name": "wordsFold", "url": "Highlight.html#method_wordsFold", "type": "method"}];
</script>
</body>
</html>
